/*
 * RemoteInvocationConfiguration.java    0.0.1    Nov 12, 2009
 * 
 * Copyright (c) 2009 mentalsmash.org
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * The use of the Apache License does not indicate that this project is
 * affiliated with the Apache Software Foundation.
 */
package org.mentalsmash.tazio.net.ril;

import java.util.HashSet;
import java.util.Set;

import org.mentalsmash.tazio.commons.TazioRuntimeException;

import com.google.inject.Module;

/**
 * This class is used to set configuration parameters for Tazio's Remote
 * Invocation Layer in order to build new {@link BaseRemoteInvoker} instances.<br/>
 * 
 * At this time configuration is carried out by adding Guice modules to an instance of
 * this class, which is the used to determine which classes to instantiate for each
 * of the required layer's components (i.e. RemoteObjectsRegistry, RemoteInvocationDispatcher...). 
 * 
 * 
 * @version 0.0.1 Nov 12, 2009
 * @author Andrea Sorbini <as@mentalsmash.org>
 * 
 */
public class RemoteInvocationConfiguration {

	private final Set<Module> modules = new HashSet<Module>();
	
	/**
	 * Creates a RemoteInvocationConfiguration instance, loading it from the
	 * specified file.
	 * 
	 * @param confpath
	 *            the location of the file containing the configuration
	 *            parameters to load
	 * @return an instance reflecting the values loaded from the specified file
	 */
	public static RemoteInvocationConfiguration fromFile(String confpath) {
		throw new TazioRuntimeException("not implemented yet");
	}
	
	/**
	 * Adds a Guice module to the list of those that will be used when building a 
	 * new {@link BaseRemoteInvoker}.
	 * @param m a Guice module providing bindings for the core RIL's components (see {@link BaseRemoteInvoker})
	 */
	public void addModule(Module m){
		if (!this.modules.contains(m)){
			this.modules.add(m);
		}
	}
	
	/**
	 * @return the list of Guice modules to be used when building a new {@link BaseRemoteInvoker}
	 */
	public Iterable<Module> getModules(){
		return this.modules;
	}
}
